<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - api.Queue</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/api.Access.html">api.Access</a></li>
	
	<li><a href="../symbols/api.Basic.html">api.Basic</a></li>
	
	<li><a href="../symbols/api.Channel.html">api.Channel</a></li>
	
	<li><a href="../symbols/api.Connection.html">api.Connection</a></li>
	
	<li><a href="../symbols/api.Dtx.html">api.Dtx</a></li>
	
	<li><a href="../symbols/api.Exchange.html">api.Exchange</a></li>
	
	<li><a href="../symbols/api.File.html">api.File</a></li>
	
	<li><a href="../symbols/api.Queue.html">api.Queue</a></li>
	
	<li><a href="../symbols/api.Stream.html">api.Stream</a></li>
	
	<li><a href="../symbols/api.Tunnel.html">api.Tunnel</a></li>
	
	<li><a href="../symbols/api.Tx.html">api.Tx</a></li>
	
	<li><a href="../symbols/handlers.html">handlers</a></li>
	
	<li><a href="../symbols/impl.html">impl</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class api.Queue
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_api_queue.js.html">queue.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class api.Queue.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/api.Queue.html#constructor">api.Queue</a></b>()
							</div>
							<div class="description">Work with queues.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class api.Queue.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#bind">bind</a></b>(ticket, queue, exchange, routingKey, nowait, arguments)
								</div>
								<div class="description">Bind queue to an exchange.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#declare">declare</a></b>(ticket, queue, passive, durable, exclusive, autoDelete, nowait, arguments)
								</div>
								<div class="description">Declare queue, create if needed.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#delete">delete</a></b>(ticket, queue, ifUnused, ifEmpty, nowait)
								</div>
								<div class="description">Delete a queue.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#purge">purge</a></b>(ticket, queue, nowait)
								</div>
								<div class="description">Purge a queue.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class api.Queue.">
					<caption>Event Summary</caption>
					<thead>
						<tr>
							<th scope="col">Event Attributes</th>
							<th scope="col">Event Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#event:bindOk">bindOk</a></b>()
								</div>
								<div class="description">Confirm bind successful.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#event:declareOk">declareOk</a></b>(queue, messageCount, consumerCount)
								</div>
								<div class="description">Confirms a queue definition.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#event:deleteOk">deleteOk</a></b>(messageCount)
								</div>
								<div class="description">Confirm deletion of a queue.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Queue.html#event:purgeOk">purgeOk</a></b>(messageCount)
								</div>
								<div class="description">Confirms a queue purge.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>api.Queue</b>()
				</div>
				
				<div class="description">
					Work with queues.

Queues store and forward messages.  Queues can be configured in the server
  or created at runtime.  Queues must be attached to at least one exchange
  in order to receive messages from publishers.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="bind"> </a>
					<div class="fixedFont">
					
					
					<b>bind</b>(ticket, queue, exchange, routingKey, nowait, arguments)
					
					</div>
					<div class="description">
						Bind queue to an exchange.

This method binds a queue to an exchange.  Until a queue is
    bound it will not receive any messages.  In a classic messaging
    model, store-and-forward queues are bound to a dest exchange
    and subscription queues are bound to a dest_wild exchange.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>ticket</b>
									
								</dt>
								<dd>An access ticket granted by the server for a certain set of access
    rights within a specific realm. Access tickets are valid within the
    channel where they were created, and expire when the channel closes.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>queue</b>
									
								</dt>
								<dd>The queue name identifies the queue within the vhost.  Queue
    names may consist of any mixture of digits, letters, and
    underscores.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>exchange</b>
									
								</dt>
								<dd>The exchange name is a client-selected string that identifies
      the exchange for publish methods.  Exchange names may consist
      of any mixture of digits, letters, and underscores.  Exchange
      names are scoped by the virtual host.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>routingKey</b>
									
								</dt>
								<dd>Specifies the routing key for the binding.  The routing key is
      used for routing messages depending on the exchange configuration.
      Not all exchanges use a routing key - refer to the specific
      exchange documentation.  If the routing key is empty and the queue
      name is empty, the routing key will be the current queue for the
      channel, which is the last declared queue.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>nowait</b>
									
								</dt>
								<dd>If set, the server will not respond to the method. The client should
    not wait for a reply method.  If the server could not complete the
    method it will raise a channel or connection exception.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>arguments</b>
									
								</dt>
								<dd>A set of arguments for the binding.  The syntax and semantics of
      these arguments depends on the exchange class.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="declare"> </a>
					<div class="fixedFont">
					
					
					<b>declare</b>(ticket, queue, passive, durable, exclusive, autoDelete, nowait, arguments)
					
					</div>
					<div class="description">
						Declare queue, create if needed.

This method creates or checks a queue.  When creating a new queue
    the client can specify various properties that control the durability
    of the queue and its contents, and the level of sharing for the queue.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>ticket</b>
									
								</dt>
								<dd>An access ticket granted by the server for a certain set of access
    rights within a specific realm. Access tickets are valid within the
    channel where they were created, and expire when the channel closes.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>queue</b>
									
								</dt>
								<dd>The queue name identifies the queue within the vhost.  Queue
    names may consist of any mixture of digits, letters, and
    underscores.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>passive</b>
									
								</dt>
								<dd>If set, the server will not create the queue.  The client can use
    this to check whether a queue exists without modifying the server
    state.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>durable</b>
									
								</dt>
								<dd>If set when creating a new queue, the queue will be marked as
      durable.  Durable queues remain active when a server restarts.
      Non-durable queues (transient queues) are purged if/when a
      server restarts.  Note that durable queues do not necessarily
      hold persistent messages, although it does not make sense to
      send persistent messages to a transient queue.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>exclusive</b>
									
								</dt>
								<dd>Exclusive queues may only be consumed from by the current connection.
      Setting the 'exclusive' flag always implies 'auto-delete'.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>autoDelete</b>
									
								</dt>
								<dd>If set, the queue is deleted when all consumers have finished
      using it. Last consumer can be cancelled either explicitly or because
      its channel is closed. If there was no consumer ever on the queue, it
      won't be deleted.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>nowait</b>
									
								</dt>
								<dd>If set, the server will not respond to the method. The client should
    not wait for a reply method.  If the server could not complete the
    method it will raise a channel or connection exception.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>arguments</b>
									
								</dt>
								<dd>A set of arguments for the declaration. The syntax and semantics
      of these arguments depends on the server implementation.  This
      field is ignored if passive is 1.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="delete"> </a>
					<div class="fixedFont">
					
					
					<b>delete</b>(ticket, queue, ifUnused, ifEmpty, nowait)
					
					</div>
					<div class="description">
						Delete a queue.

This method deletes a queue.  When a queue is deleted any pending
    messages are sent to a dead-letter queue if this is defined in the
    server configuration, and all consumers on the queue are cancelled.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>ticket</b>
									
								</dt>
								<dd>An access ticket granted by the server for a certain set of access
    rights within a specific realm. Access tickets are valid within the
    channel where they were created, and expire when the channel closes.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>queue</b>
									
								</dt>
								<dd>The queue name identifies the queue within the vhost.  Queue
    names may consist of any mixture of digits, letters, and
    underscores.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>ifUnused</b>
									
								</dt>
								<dd>If set, the server will only delete the queue if it has no
      consumers. If the queue has consumers the server does does not
      delete it but raises a channel exception instead.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>ifEmpty</b>
									
								</dt>
								<dd>If set, the server will only delete the queue if it has no
      messages. If the queue is not empty the server raises a channel
      exception.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>nowait</b>
									
								</dt>
								<dd>If set, the server will not respond to the method. The client should
    not wait for a reply method.  If the server could not complete the
    method it will raise a channel or connection exception.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="purge"> </a>
					<div class="fixedFont">
					
					
					<b>purge</b>(ticket, queue, nowait)
					
					</div>
					<div class="description">
						Purge a queue.

This method removes all messages from a queue.  It does not cancel
    consumers.  Purged messages are deleted without any formal "undo"
    mechanism.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>ticket</b>
									
								</dt>
								<dd>An access ticket granted by the server for a certain set of access
    rights within a specific realm. Access tickets are valid within the
    channel where they were created, and expire when the channel closes.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>queue</b>
									
								</dt>
								<dd>The queue name identifies the queue within the vhost.  Queue
    names may consist of any mixture of digits, letters, and
    underscores.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>nowait</b>
									
								</dt>
								<dd>If set, the server will not respond to the method. The client should
    not wait for a reply method.  If the server could not complete the
    method it will raise a channel or connection exception.</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
				<div class="sectionTitle">
					Event Detail
				</div>
				
					<a name="event:bindOk"> </a>
					<div class="fixedFont">
					
					
					<b>bindOk</b>()
					
					</div>
					<div class="description">
						Confirm bind successful.

This method confirms that the bind was successful.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:declareOk"> </a>
					<div class="fixedFont">
					
					
					<b>declareOk</b>(queue, messageCount, consumerCount)
					
					</div>
					<div class="description">
						Confirms a queue definition.

This method confirms a Declare method and confirms the name of the
    queue, essential for automatically-named queues.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>queue</b>
									
								</dt>
								<dd>The queue name identifies the queue within the vhost.  Queue
    names may consist of any mixture of digits, letters, and
    underscores.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>messageCount</b>
									
								</dt>
								<dd>Reports the number of messages in the queue, which will be zero
      for newly-created queues.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>consumerCount</b>
									
								</dt>
								<dd>Reports the number of active consumers for the queue. Note that
      consumers can suspend activity (Channel.Flow) in which case they
      do not appear in this count.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:deleteOk"> </a>
					<div class="fixedFont">
					
					
					<b>deleteOk</b>(messageCount)
					
					</div>
					<div class="description">
						Confirm deletion of a queue.

This method confirms the deletion of a queue.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>messageCount</b>
									
								</dt>
								<dd>Reports the number of messages purged.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:purgeOk"> </a>
					<div class="fixedFont">
					
					
					<b>purgeOk</b>(messageCount)
					
					</div>
					<div class="description">
						Confirms a queue purge.

This method confirms the purge of a queue.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>messageCount</b>
									
								</dt>
								<dd>Reports the number of messages purged.</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Nov 04 2010 22:16:21 GMT+0200 (EET)
		</div>
	</body>
</html>
